MINOR: fixing JavaDocs and other cleanup #17207
Open
+70
−45
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mjsax
commented
Sep 16, 2024
| @@ -1452,7 +1456,7 @@ public CloseOptions leaveGroup(final boolean leaveGroup) { | |||
| * This will block until all threads have stopped. | |||
| */ | |||
| public void close() { | |||
| close(Long.MAX_VALUE, false); | |||
| close(Optional.empty(), false); | |||
There was a problem hiding this comment.
Changing this to Optional to unify the log message (cf other changes).
chia7712
reviewed
Sep 16, 2024
| "and the registered exception handler opted to " + action + "." + | ||
| " The streams client is going to shut down now. ", throwable); | ||
| log.error(String.format( | ||
| "Encountered the following exception during processing and the registered exception handler" + |
There was a problem hiding this comment.
Pardon me, why not using {} placeholder directly?
chia7712
reviewed
Sep 17, 2024
There was a problem hiding this comment.
@mjsax thanks for this patch. overall LGTM
It seems StreamConfig prefers to use String.format rather than slf4j "parameterized messages". It is cool to have consistent code style, but using slf4j format is more simple and fast (https://www.slf4j.org/faq.html#logging_performance).
| final long timeoutMs; | ||
| if (timeout.isPresent()) { | ||
| timeoutMs = timeout.get(); | ||
| log.debug("Stopping Streams client with timeoutMillis = {} ms.", timeoutMs); |
There was a problem hiding this comment.
nit: there is "ms" already, so timeoutMillis could be simplified to timeout
| @@ -1309,7 +1309,11 @@ public static boolean getBoolean(final Map<String, Object> configs, final String | |||
| } else if (value instanceof String) { | |||
| return Boolean.parseBoolean((String) value); | |||
| } else { | |||
| log.warn("Invalid value (" + value + ") on internal configuration '" + key + "'. Please specify a true/false value."); | |||
| log.warn(String.format( | |||
There was a problem hiding this comment.
maybe we use placeholder?
log.warn(
"Invalid value ({}) on internal configuration '{}}'. Please specify a true/false value.",
value,
key
);| @@ -1321,7 +1325,11 @@ public static long getLong(final Map<String, Object> configs, final String key, | |||
| } else if (value instanceof String) { | |||
| return Long.parseLong((String) value); | |||
| } else { | |||
| log.warn("Invalid value (" + value + ") on internal configuration '" + key + "'. Please specify a numeric value."); | |||
| log.warn(String.format( | |||
| @@ -1331,7 +1339,11 @@ public static String getString(final Map<String, Object> configs, final String k | |||
| if (value instanceof String) { | |||
| return (String) value; | |||
| } else { | |||
| log.warn("Invalid value (" + value + ") on internal configuration '" + key + "'. Please specify a String value."); | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thing IntelliJ highlighted...